package com.example.common.config;

import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;

/**
 * Swagger 配置类
 * 用于创建 RESTful API 文档
 * 相关涉及 book user 模块
 */
@Configuration
@EnableSwagger2WebMvc
public class SwaggerConfig {

    /**
     * 提供通用的 Docket 构建方法，供其他模块复用
     * 包含请求路径选择器、API 选择器、API 文档信息构建
     */
    public Docket createRestApi(String basePackage, String title) {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage(basePackage))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo(title));
    }

    /**
     * 创建 API 文档信息
     * 包含标题、描述、版本信息
     */
    private ApiInfo apiInfo(String title) {
        return new ApiInfoBuilder()
                .title(title)
                .description(title + " 的 API 接口文档")
                .version("1.0.0")
                .build();
    }
}
